This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.

Features

System requirements

Starting with v0.105.0, the geomap uses MapLibre GL which requires WebGL v1 support. In general, most devices will support it because browsers/Electron can render it in software if needed.

If the map could not be drawn because WebGL could not be initialized, an error message will appear instead of the map (This map can't be drawn because WebGL isn't available…).

Interaction

Creating a new geo map

Right click on an existing note in the Note Tree and select Insert child note → Geo Map.

By default the map will be empty and will show the entire world.

Repositioning the map

The position on the map and the zoom are saved inside the map note and restored when visiting again the note.

Adding a marker using the map

Adding a new note using the plus button

  1. To create a marker, first navigate to the desired point on the map. Then press the Add marker button at the center-bottom of the map.

  2. Once pressed, the map will enter in the insert mode, as illustrated by the notification. Additionally, a preview of the marker will be shown at the cursor position.

    Simply click the point on the map where to place the marker. To cancel, press either the  Escape key or press again the Add marker button.

  3. Once clicked, the marker will show up on the map and a popup will show to the right with the title already selected to be changed.

Adding a new note using the contextual menu

  1. Right click anywhere on the map, where to place the newly created marker (and corresponding note).
  2. Select Add a marker at this location.
  3. Once clicked on a position on the map, the marker will show up on the map and a popup will show to the right with the title already selected to be changed.

Adding an existing note from the note tree

  1. Select the desired note in the Note Tree.
  2. Hold the mouse on the note and drag it to the map to the desired location.
  3. The map should be updated with the new marker.

This works for:

How the location of the markers is stored

The location of a marker is stored in the #geolocation attribute of the child notes:

This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.

Repositioning markers

Once a marker is set, it can be repositioned using one of the two ways:

After clicking the button to move the marker, click at the desired position on the map to replace it. To cancel the operation, press Escape.

Interaction with the markers

Popup view

When a marker or a track is clicked, a popup will open to the right which contains the following information:

To dismiss the popup:

When a marker is clicked, the map will automatically adjust the viewport so that the marker is still visible with the popup open. The currently selected marker is shown slightly bigger.

It is possible to switch between markers by clicking on them even when the popup view is already open.

Markers can have Internal (reference) links between them and clicking on such a link will automatically adjust the viewport and the popup view to the new note.

Contextual menu

It's possible to press the right mouse button to display a contextual menu.

  1. If right-clicking an empty section of the map (not on a marker), it allows to:
    1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
    2. Open the location using an external application (if the operating system supports it).
    3. Adding a new marker at that location.
  2. If right-clicking on a marker, it allows to:
    1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
    2. Open the location using an external application (if the operating system supports it).
    3. Open the note in a new tab, split or window.
    4. Button to remove the marker from the map, which can optionally delete its corresponding note. Removing a marker without deleting the note will only remove its #geolocation attribute (case in which the coordinates have to be manually added back in in order to get the note to show on the map again).

Icon and color of the markers

The markers will have the same icon as the note.

It's possible to add a custom color to a marker by assigning them a #colorattribute such as #color=green.

Adding the coordinates manually

In a nutshell, create a child note and set the #geolocation attribute to the coordinates.

The value of the attribute is made up of the latitude and longitude separated by a comma.

Adding from Google Maps

  1. In Google Maps, on the web:
    1. Look for a desired location, right click on it and a context menu will show up.
    2. Simply click on the first item displaying the coordinates and they will be copied to clipboard.
  2. In Trilium, create a child note under the map.
  3. Then paste the value inside the text box into the #geolocation attribute of a child note of the map (don't forget to surround the value with a "character).

Adding from OpenStreetMap

Similarly to the Google Maps approach:

  1. Go to any location on openstreetmap.org and right click to bring up the context menu. Select the Show address item.
  2. The address will be visible in the top-left of the screen, in the place of the search bar. Select the coordinates and copy them into the clipboard.
  3. Simply paste the value inside the text box into the #geolocation attribute of a child note of the map and then it should be displayed on the map.

Adding GPS tracks (.gpx)

Trilium can display GPS tracks on the geo map, in the form of .gpx files.

To add a track, either:

  1. Drag & drop a .gpx file inside the geo map in the note tree.
    1. In order for the file to be recognized as a GPS track, it needs to show up as application/gpx+xml in the File type field.
  2. Press the Add a GPS track from a GPX file which will directly prompt for a GPX file and import it as a subnote of the collection.

When going back to the map, the track should now be visible.

The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the color of the note. The end marker is displayed with a distinct icon.

If the track file contains multiple tracks, they will all be displayed as well as markers. Trilium will also split a single track that happens to have non-continuous points.

If the GPX contains waypoints, they will also be displayed, including their names.

When the track is clicked, the entire route is brought into view, as well as the right popup will indicate details about the track such as distance, duration and the elevation map. This information is also displayed when clicking the .gpx note itself.

When clicking on the markers of a track (whether it's the start or stop builtin markers, or custom markers that are part of the track), only that marker is brought into view, as opposed to the entire route.

Read-only mode

When a map is read-only all editing features will be disabled such as:

To set a map as read-only, go to Note buttons → Editable → Read-only (on the new layout, or in Basic Properties on the Ribbon for the old layout).

Configuration

Map Style

The styling of the map can be adjusted in the Collection Properties or manually via the #map:style attribute.

The geo map comes with two different types of styles:

The default theme is Versatiles Colorful (vector).

3D view with buildings

Trilium v0.105.0 introduces a 3D view, courtesy of MapLibre GL. To enter 3D mode, simply press the corresponding button at the bottom-right of the map or press Ctrl and drag across the map.

The buildings will only appear from zoom 14 onwards to avoid lag.

Custom map style / tiles

Starting with v0.102.0 it is possible to use custom tile sets, but only in raster format.

To do so, manually set the #map:style labelto the URL of the tile set. For example, to use Esri.NatGeoWorldMap, set the value to https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}.

Additionally:

Custom vector map support is planned, but not yet implemented.

Other options

The following options can be configured either via the Collection Properties, by clicking on the settings (Gear icon). Alternatively, each of these options also have a corresponding label that can be set manually.